home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / proboard / prp102a.zip / PRP.DOC < prev    next >
Text File  |  1996-06-03  |  10KB  |  258 lines
  1. ╔══════════════════════════════════════════════╗
  2. ║      ProBoard Request Processor v1.02a       ║
  3. ║ Written by Tom Torfs (2:292/516@fidonet.org) ║
  4. ╚══════════════════════════════════════════════╝
  5.  
  6. This is freeware. You are encouraged to copy this program
  7. and give copies to your friends. You may not, however,
  8. change this program or its documentation in any way
  9. or distribute modified versions of the original archive.
  10.  
  11. *** OVERVIEW ***
  12.  
  13. ProBoard Request Processor is a simple program that quickly
  14. generates responses to file requests, even from cd-roms, by
  15. reading the ProBoard index files directly.
  16.  
  17. It is compatible with FrontDoor, McMail and other mailers that
  18. support external file request processors.
  19.  
  20. Both normal file requests and update requests (only if a file
  21. is newer than a certain date) are supported. Separate request
  22. limits for secure and unsecure sessions, and unlimited requests
  23. from free areas are also supported.
  24.  
  25. If you are looking for bells and whistles, like timeslots,
  26. passwords for files, etc. this program is not for you.
  27. If you are looking for a simple, robust and most of all
  28. fast file request processor for your ProBoard-based BBS,
  29. this is what you've been waiting for.
  30.  
  31. *** INSTALLATION ***
  32.  
  33. First unpack the archive into a separate directory
  34. (recommended) or into your mailer's directory.
  35.  
  36. A) FrontDoor
  37.  
  38. Launch FDSETUP and set the following information in
  39. Mailer/File requests/Request processor:
  40.  
  41. Program   C:\FD\PRP\PRP.EXE =R =T =X =A "=O"    (*)
  42. Enabled   Yes
  43. Swapping  No                                    (**)
  44.  
  45. (*) use the correct path, of course
  46. (**) set to Yes if you're really low on memory
  47.  
  48. Oh yes, of course this is only possible with the registered
  49. version of FrontDoor. But you knew that, didn't you ?
  50.  
  51. B) McMail
  52.  
  53. Set up the following command string:
  54.  
  55. ReqProcessor C:\MCMAIL\PRP\PRP.EXE =PFL =PXL =SU =PA "=RS"   (*)
  56.  
  57. (*) use the correct path, of course
  58.  
  59. C) Others
  60.  
  61. Set up the command line as follows (look in your mailer's manual
  62. for the required macros):
  63.  
  64. PRP.EXE <infile> <outfile> <SECURE|UNSECURE> <address> "<sysopname>"
  65.  
  66. If you provide me with the correct command line for another mailer,
  67. please inform me. It will be added to this doc and I will give
  68. credit to you.
  69.  
  70. To upgrade from a previous version of PRP, simply unpack the
  71. archive into the PRP directory. Your configuration and template
  72. files will be left intact. However, to use some of the new
  73. features (logging, for example), changing the configuration file
  74. will be necessary.
  75.  
  76. *** CONFIGURATION ***
  77.  
  78. The configuration file must be named PRP.CFG and must be in the
  79. same directory as PRP.EXE. It is a text file configuration,
  80. and can contain the following keywords. Everything after a
  81. semicolon (;) is treated as a comment and ignored.
  82.  
  83. ADDRESS=<your main address>
  84. Your main address, in the form zone:net/node.point. Any omitted
  85. fields (e.g. point) are assumed to be zero.
  86. This address is used as the origin for the file request response
  87. messages.
  88.  
  89. MAGIC=<list with magic file names>
  90. Defines the path and filename of the file containing a list
  91. of magic filenames (same file as the alias file in FrontDoor).
  92. Each line contains a magic name, followed by at least one
  93. space and then the full path of the corresponding file name
  94. (wildcards supported).
  95. If this is omitted, no magic files will be available.
  96.  
  97. PBPATH=<path to ProBoard system directory>
  98. If you omit this, the environment variable PB will be read, and
  99. if that isn't set, C:\PB will be assumed.
  100.  
  101. LOGFILE=<logfile>
  102. Defines the path and filename of the logfile. Leave empty, or
  103. simply omit, to disable logging.
  104.  
  105. MAXFILES=<maximum number of files>
  106. Defines the maximum number of files a system may request per
  107. session. If you omit this or set it to zero, there is no
  108. limit.
  109.  
  110. MAXKB=<maximum number of kilobytes>
  111. Defines the maximum number of kilobytes a system may request
  112. per session. If you omit this or set it to zero, there is no
  113. limit.
  114.  
  115. MAXLEVEL=<maximum security level>
  116. Defines the maximum security level a file area may have in
  117. ProBoard for a system to be allowed to request from it. Set
  118. this to 32767 (or omit it) if you want no limit.
  119.  
  120. MAXFILES_SECURE=<maximum number of files>
  121. Same as MAXFILES but for secure sessions. If you omit this the
  122. setting from MAXFILES will be used.
  123.  
  124. MAXKB_SECURE=<maximum number of kilobytes>
  125. Same as MAXKB but for secure sessions. If you omit this the
  126. setting from MAXKB will be used.
  127.  
  128. MAXLEVEL_SECURE=<maximum security level>
  129. Same as MAXLEVEL but for secure sessions. If you omit this the
  130. setting from MAXLEVEL will be used.
  131.  
  132. FREEFILES=<YES|NO>
  133. If set to YES, request limits are ignored for file areas marked
  134. as 'free' in ProBoard. This is also the default behaviour.
  135. This only affects number of files & kb limits, security level
  136. limits are still respected even if the area is marked as free.
  137.  
  138. FREEMAGIC=<YES|NO>
  139. If set to YES, request limits are ignored for files requested
  140. using magic names. This is also the default behaviour.
  141.  
  142. *** RESPONSE TEMPLATE ***
  143.  
  144. The response template file must be named PRP.TPL and must be in
  145. the same directory as PRP.EXE. If this file isn't found, no
  146. response will be generated.
  147.  
  148. The first character of each line can define when a line should
  149. be included in the response:
  150.  
  151. ;       comment, always ignored
  152. +       only if the request succeeded entirely
  153. *       only if the request succeeded at least partly
  154. -       only if the request didn't succeed entirely
  155. !       only if the request limits were exceeded
  156. ?       only if some of the requested files weren't found
  157. #       always include this line
  158.  
  159. All other characters will cause the line to be always included. The
  160. # character is useful if you want a line beginning with any of the
  161. above characters to be always included.
  162.  
  163. You can use the following macros in the response template (case
  164. sensitive):
  165.  
  166. @SYSOPNAME@     name of sysop of requesting system
  167. @SYSOPFIRST@    first name of sysop of requesting system
  168. @MAXFILES@      maximum number of files this system can request
  169.                 per session (UNLIMITED if 0)
  170. @MAXKB@         maximum number of kilobytes this system can request
  171.                 per session (UNLIMITED if 0)
  172. @SENTFILES@     names and descriptions of sent files (everything
  173.                 else on this line will be ignored)
  174. @OVERLIMIT@     names and descriptions of files which exceeded limits
  175.                 (everything else on this line will be ignored)
  176. @NOTFOUND@      names of files for which no match was found
  177.                 (everything else on this line will be ignored)
  178.  
  179. See the example SAMPLE.TPL for an example on how to use these.
  180.  
  181. *** FILENAME MATCHING ***
  182.  
  183. For normal files, extensions are ignored. So when someone freqs
  184. PRP102.ZIP, PRP102.ARJ will also match. Also only one file
  185. with the same base name will be sent. So if someone freqs
  186. PRP102.* and you have both PRP102.ARJ and PRP102.ZIP, only
  187. the first will be sent.
  188.  
  189. The above isn't used if the last two characters of the extension
  190. are numbers. So if someone freqs NODEDIFF.* the files NODEDIFF.Z89,
  191. NODEDIFF.Z96 etc. will be sent. But if someone freqs NODELIST.Z96
  192. he will only get NODELIST.Z96 and not for example NODELIST.Z89.
  193.  
  194. *** FILES.BBS ***
  195.  
  196. When a match is found, the file size and date/time stamp are
  197. looked up. It ignores this info in the FILES.BBS if present, so
  198. that an incorrect FILES.BBS doesn't cause incorrect results (like
  199. an attempt to send a missing file you forgot to delete from
  200. FILES.BBS etc.). Only the description is read from the FILES.BBS,
  201. with all optional information like file size, date/time, download
  202. counters etc. stripped.
  203. This way I also avoid compatibility problems with the different
  204. date formats etc.
  205. Extended descriptions are supported. The first non-whitespace character
  206. on each extended description line must be a +, | or >.
  207.  
  208. When a file is requested using a magic name, the description is searched
  209. for in FILES.BBS in the same directory as the file. For normal files, the
  210. File Listing name from the ProBoard file area configuration is used.
  211.  
  212. *** ERRORLEVELS ***
  213.  
  214. 0 = all OK
  215. 1 = syntax error
  216. 2 = file error
  217. 3 = memory error
  218.  
  219. *** CONTACTING THE AUTHOR ***
  220.  
  221. Although this is a freeware program, I am willing to give (limited)
  222. support for it. You can write netmail to me at 2:292/516@fidonet.org
  223. or call my BBS at 32-15-24.62.32 and leave a message.
  224.  
  225. *** SOURCE CODE ***
  226.  
  227. Sorry, no source code for this one. If you want to write your own
  228. file request processor, you'll find enough information in the
  229. FrontDoor development kit (FDDEV) to do so without having to see
  230. my source.
  231.  
  232. *** HISTORY OF PRP ***
  233.  
  234. Version         Release date    Changes
  235.  
  236. 1.0             9 Apr 1996      Original version
  237.  
  238. 1.01            3 May 1996      * Added file sharing support for
  239.                                   multiline BBSes
  240.  
  241. 1.02            27 May 1996     * Unlimited requests from free
  242.                                   file areas & free magic names
  243.                                   (configurable)
  244.                                 * Logging now possible
  245.                                 * Added documentation for setup
  246.                                   with McMail mailer
  247.                                 * Miscellaneous small changes to
  248.                                   the documentation & code
  249.  
  250. 1.02a           3 June 1996     * OS/2 problem fixed
  251.  
  252. *** CREDITS ***
  253.  
  254. Thanks to Jacques Theys for suggesting the file sharing compability
  255. and for providing the correct McMail setup string.
  256.  
  257. *** END OF DOCUMENT ***
  258.